Schema Changes from V12.0 through V12.37

The tables below includes elements added in schema versions 12.0 through 12.37:

New Elements in V12.0 through V12.20
New Elements in V12.21 through V12.25
New Elements in V12.26 through V12.37

New Elements in V12.0 through V12.20

New Element	Parent of	Child of	Comments
`pinlessDebitResponse`	`networkName`	`sale`
`networkName`		`pinlessDebitResponse`	The `networkName` element defines the Debit Network through which Worldpay processed the transaction. This element appears only if you use the Worldpay Prime PINless Debit service and Worldpay routed the transaction through a Debit Network for approval.
`pinlessDebitRequest`	`routingPreference` `preferredDebitNetworks`	`sale`	You can use this element up to 12 times in a transaction to designate a list of preferred debit networks in priority order. The use of this element applies only to merchants using the Prime - PINless Debit Routing service.
`routingPreference`		`pinlessDebitRequest`	Defines the merchant preference for the routing of this transaction. Possible values are: pinlessDebitOnly signatureOnly regular The use of this element applies only to merchants using the Prime - PINless Debit Routing service.
`preferredDebitNetworks`	`debitNetworkName`	`pinlessDebitRequest`	Contains a repeatable child element (up to 12 times) that allows you to specify the preferred debit network or networks for processing this transaction. The use of this element applies only to merchants using the Prime - PINless Debit Routing service.
`debitNetworkName`		`preferredDebitNetworks`	The name(s) of the preferred debit network(s). You can include up to 12 names.
`accountRangeId`		`registerTokenResponse` `enhancedAuthResponse`	A Worldpay assigned value representing the account range of the card used in the transaction.
`paymentAccountReferenceNumber`		`authorizationResponse` `saleResponse`	The value, assigned by the card network, is a constant correlation value that represents the cardholder account regardless of updated account numbers or reissued cards. Worldpay always returns the value, when the applicable card network makes it available.
`eventType`		`fraudCheck`	Defines the type of event occurring. Enum values are: payment login account_creation details_changes
`accountLogin`		`fraudCheck`	Define the account login name.
`accountPasshash`		`fraudCheck`	Defines the SHA-2 hash of the password in hexadecimal format. Depending on the hash algorithm, the value must be either 128, 96, 64, or 56 characters.
`disbursementType`		`fastAccessFunding`	Describes the funds disbursement associated with the transaction. If you do not include this element, the value defaults to VMD, Merchant Disbursement. See the cnpAPI Reference Guide for a complete list of enum values.
`translateToLowValueTokenRequest`	`orderId` `token`	cnpOnlineRequest batchRequest	A transaction type used to generate a low value token for a submitted high value token.
`translateToLowValueTokenResponse`	`orderId` `paypageRegistrationId` `response` `message` `responseTime`	`cnpOnlineResponse` `batchResponse`	Response message for a `translateToLowVaueTokenRequest`.
`lodgingInfo`	`hotelFolioNumber` `checkInDate` `checkOutDate` `duration` `customerServicePhone` `programCode` `roomRate` `roomTax` `numAdults` `propertyLocalPhone` `fireSafetyIndicator` `lodgingCharge`	`authorization` `capture captureGivenAuth` `credit` `forceCapture` `sale`	Defines a number of lodging related data points that, when submitted, can result in a more favorable interchange rate.
`hotelFolioNumber`		`lodgingInfo`	Defines customer folio number from your system.
`checkInDate`		`lodgingInfo`	The date the customer checked in.
`checkOutDate`		`lodgingInfo`	The date the customer checked out.
`duration`		`lodgingInfo`	Defines the number of nights the guest stays (or plans to stay) at the facility. Note: For Discover it is: # nights * # rooms.
`customerServicePhone`		`lodgingInfo`	Defines customer service number of the facility
`programCode`		`lodgingInfo`	Enum values: LODGING NOSHOW ADVANCED DEPOSIT
`roomRate`		`lodgingInfo`	Defines the per day room charges exclusive of any taxes and fees.
`roomTax`		`lodgingInfo`	Defines the per day room tax.
`numAdults`		`lodgingInfo`	Defines the total number of adult guests staying (or planning to stay) at the facility (i.e., all booked rooms).
`propertyLocalPhone`		`lodgingInfo`	Defines local phone number of the facility. For a MasterCard transaction, you must include a value for this element to achieve better interchange rates.
`fireSafetyIndicator`		`lodgingInfo`	Defines whether or not the facility conforms to the requirements of the Hotel and Motel Fire Safety Act of 1990, or similar legislation.
`lodgingCharge`	`name`	`lodgingInfo`	Through its child element, defines the type of additional charges associated with the stay of the guest. You can include this element a maximum of six times in a transaction.
`name`		lodgingCharge	Defines the type of additional charges associated with the stay of the guest. Enum values are: RESTAURANT GIFTSHOP MINIBAR TELEPHONE LAUNDRY OTHER
`encryptionKeyId`		`registerTokenRequest`	The Id of the encryption key used to encrypt the account number and/or validation number.
`encryptedAccuntNumber`		`registerTokenRequest`	The encrypted account number.
`encryptedCardValidationNum`		`registerTokenRequest`	The encrypted card validation number.
`ctxPaymentInformation` (Batch transactions only)	`ctxPaymentDetail`	`accountInfo`	You can use this element to submit a description of certain Instruction Based Dynamic Payout transactions (Sub-merchant Debit/Credit or Vendor Debit/Credit). You define the content using the `ctxPaymentDetail` child element. The information appears in the extended detail section of the receiver’s bank statement, if supported by the receiving bank.
`ctxPaymentDetail`		`ctxPaymentInformation`	The description of the Sub-merchant Debit/Credit or Vendor Debit/Credit transaction. The information appears in the extended detail section of the receiver’s bank statement, if supported by the receiving bank.
`tokenUrl`		`token` `updatedToken` `originalToken`	Used to submit the token URL value when submitting an Account Updater request (Batch only) via Access Worldpay. This value must use the following pattern: http.?://./.
`fundingCustomerId`		`fastAccessFunding` `physicalCheckCredit` `physicalCheckDebit` `reserveCredit` `reserveDebit`	Added to all merchant use of Dynamic Payout.
`customerCredit`	`fundingCustomerId` `customerName` `fundsTransferId` `amount` `accountInfo` `customIdentifier`	`batchRequest`	New transaction type for merchants using Dynamic Payout.
`customerCreditResponse`	`cnpTxnId` `fundsTransferId` `response` `responseTime` (Online only) `postDate` `message`	`batchResponse`	New transaction type for merchants using Dynamic Payout.
`customerDebit`	`fundingCustomerId` `customerName` `fundsTransferId` `amount` `accountInfo` `customIdentifier`	`batchRequest`	New transaction type for merchants using Dynamic Payout.
`customerDebitResponse`	`cnpTxnId` `fundsTransferId` `response` `responseTime` (Online only) `postDate` `message`	`batchResponse`	New transaction type for merchants using Dynamic Payout.
`payoutOrgCredit`	`fundingCustomerId` `fundsTransferId` `amount`	`batchRequest` `cnpOnlineRequest`	New transaction type for merchants using Dynamic Payout.
`payoutOrgCreditResponse`	`cnpTxnId` `fundsTransferId` `response` `responseTime` (Online only) `postDate` `message`	`batchResponse` `cnpOnlineResponse`	New transaction type for merchants using Dynamic Payout.
`payoutOrgDebit`	`fundingCustomerId` `fundsTransferId` `amount`	`batchRequest` `cnpOnlineRequest`	New transaction type for merchants using Dynamic Payout.
`payoutOrgDebitResponse`	`cnpTxnId` `fundsTransferId` `response` `responseTime` (Online only) `postDate` `message`	`batchResponse`, `cnpOnlineResponse`	New transaction type for merchants using Dynamic Payout.
`skipRealtimeAU`		`authorization` `sale`	Setting this element to true allows you to skip any real-time account updates on the submitted transaction.
`accountUpdateSource`		`accountUpdater`	Used to indicate if the source of the update information is real-time (R) or non-real-time update from cache (N).
`authenticationProtocolVersion`		`cardholderAuthentiction`	Used to indicate if the authentication used 3DS1 or 3DS2.
`merchantCategoryCode`		`authorization` `captureGivenAuth` `credit` `forceCapture` `sale`	Used to dynamically set the MCC on a per transaction basis.
`location`		`cnpOnlineResponse`	Provides the processing location for merchants using Hot-Hot.
`tokenAuthenticationValue`		`cardholderAuthentication`	Used for Mastercard Digital Secure Remote Payments
`pinlessDebitResponse`	`networkName`	`authReversalResponse` `captureResponse`	Existing element added to two more transaction types.
`copayAmount`		healthcareAmounts	Allows the designation of copay amounts.
`debitResponse`		pinlessDebitResponse	Provides info about decline reason from the debit network.
`debitMessage`		pinlessDebitResponse	Provides info about decline reason from the debit network.
`businessIndicator`		authorization, captureGivenAuth, credit, forceCapture, sale	Allows you to designate the transaction as consumer bill pay.
`orderId`		capture, credit	We added the orderId element to the (linked) capture and credit transactions allowing you to designate a new orderId for the capture or credit.
`depositTransactionReversal`	`cnpTxnId` `amount` `surchargeAmount` `enhancedData` `processingInstructions` `customBilling` `lodgingInfo` `pin`	`litleOnlineRequest` `batchRequest`
`depositTransactionReversalResponse`	`cnpTxnId` `response` `responseTime` `postDate` `message` `location` `recyclingResponse`	`litleOnlineResponse` `batchResponse`
`refundTransactionReversal`	`cnpTxnId` `amount` `surchargeAmount` `enhancedData` `processingInstructions` `customBilling` `lodgingInfo` `pin`	`litleOnlineRequest` `batchRequest`
`refundTransactionReversalResponse`	`cnpTxnId` `response` `responseTime` `postDate` `message` `location` `recyclingResponse`	`litleOnlineResponse` `batchResponse`

Other schema changes (v12.0 through 12.20)

New enumerations added to the processingType element to support recurring and installment card on file transactions. The new enumerations are: initialRecurring, and initialInstallment.
New enumerations added to the processingType element to support card on file transactions. The new enumerations are: initialCOF, merchantInitiatedCOF, and cardholderInitiatedCOF.
The Submerchant Credit/Debit and Vendor Credit/Debit transactions moved from the cnpTransaction schema to both the cnpOnline and cnpBatch transaction schema files. This was done to accommodate the use of the ctxPaymentInformation element, which is Batch only.
To accommodate 3DS2, the authenticationTransactionId changed from a Base 64 encoded item to a string. Also, the maxLength changed from 28 to 36.
The maxLength of the orderId element changed from 25 to 256 characters.
IC added as an enum value for the type element.

New Elements in V12.21 through V12.25

New Element	Parent of	Child of	Comments
`cardholderAddress`	`addressLine1` `addressLine2` `addressLine3` `city` `state` `zip` `country`	`fastAccessFunding`	Defines the postal mailing address of the cardholder For FastAccess funding transactions.
`vendorAddress`	`addressLine1addressLine2` `addressLine3` `city` `state` `zip` `country`	`vendorCredit` `vendorDebit`	Defines the postal mailing address of the vendor in a `vendorDebit` or `vendorCredit` transaction. You must include the address information Fast-Access funding transactions.
`accountUsername`		`customerInfo`	Optional in the schema but required for the Guaranteed Payments service to process a successful fraud check with Signifyd.
`userAccountNumber`		`customerInfo`
`userAccountEmail`		`customerInfo`
`membershipId`		`customerInfo`
`membershipPhone`		`customerInfo`
`membershipEmail`		`customerInfo`
`membershipName`		`customerInfo`
`accountCreatedDate`		`customerInfo`
`userAccountPhone`		`customerInfo`
`retailerAddress`		`authorization` `captureGivenAuth` `sale`	Defines the postal mailing address and other information about the underlying retailer selling the product. Required for Discover Installment Payments and American Express Bill Pay.
`additionalCOFData`		`authorization` `captureGivenAuth` `sale`	Defines additional Card on File data, including information for Visa installments and the Visa Buy Now, Pay Later (BNPL) program.
`accountUsername`		`customerInfo`	Optional in the schema but required for the Guaranteed Payments service to process a successful fraud check with Signifyd.Required for Guaranteed Payments service.
`userAccountNumber`		`customerInfo`
`userAccountEmail`		`customerInfo`
`membershipId`		`customerInfo`
`membershipPhone`		`customerInfo`
`membershipEmail`		`customerInfo`
`membershipName`		`customerInfo`
`accountCreatedDate`		`customerInfo`
`userAccountPhone`		`customerInfo`
`discountCode`		`enhancedData`
`discountPercent`		`enhancedData`
`fulfilmentMethodType`		`enhancedData`	Required for the Guaranteed Payments service. Describes the fulfillment method for the customer's order. Enum values are: `DELIVERY` `COUNTER_PICKUP` `CURBSIDE_PICKUP` `LOCKER_PICKUP`
`itemCategory`		`lineItemData`	Required for the Guaranteed Payments service.
`itemSubCategory`		`lineItemData`
`productId`		`lineItemData`
`productName`		`lineItemData`
`checkoutId`		`authorizationResponse` `authReversalResponse` `captureResponse` `captureGivenAuthResponse` `creditResponse echeckCreditResponse echeckSalesResponse forceCaptureResponse saleResponse`
`bookingId`		`lodgingInfo`	Defines optional lodging-related data points that, when submitted, can result in a more favorable interchange rate.
`passengerName`		`lodgingInfo`
`propertyAddress`	`name` `city` `region` `country`	`lodgingInfo`
`travelPackageIndicator`		`lodgingInfo`
`smokingPreference`		`lodgingInfo`
`numberOfRooms`		`lodgingInfo`
`tollFreePhoneNumber`		`lodgingInfo`

Other schema changes (v12.21 through 12.25)

The maxLength of the authenticationValue element changed from 56 to 512 characters.
The fundingCustomerId and fundingSubmerchantId elements are now optional child elements for fastAccessFunding and vendorCredit and vendorDebit.
New enumerations added to orderChannel to support Guaranteed Payments. The new enumerations are: IN_STORE_KIOSK, MARKETPLACE, MIT, MOBILE_APP, PHONE, SOCIAL, WEB.

New Elements in V12.26 through V12.37

The table below describes elements added, changed, or deleted in schema versions 12.26 through 12.37. Click the element links to navigate to the Worldpay eComm cnpAPI Reference Guide for further information.

Schema Version	Summary of Element Additions/Changes	Comments
12.26	New Element added: `passengerTransportData` Parent Elements: `authorization`,`sale`,`capture`, `credit`, `forceCapture`. `captureGivenAuth`,`depositTransactionReversal`,`refundTransactionReversal` Child Elements: `passengerName`, `ticketNumber`, `issuingCarrier`, `carrierName`, `restrictedTicketIndicator`, `numberOfAdults`, `numberOfChildren`, `customerCode`, `arrivalDate`, `issueDate`, `travelAgencyCode`, `travelAgencyName`, `computerizedReservationSystem`, `creditReasonIndicator`, `ticketChangeIndicator`, `tripLegData` New Element added: tripLegData Parent Element: `passengerTransportData` Child Elements: `tripLegNumber`, `departureCode`, `carrierCode`, `serviceClass`,`stopOverCode`, `destinationCode`, `fareBasisCode`, `departureDate`, `originCity`, `travelNumber`, `departureTime`, `arrivalTime`, `remarks`	New elements and child elements added in support of railway travel.
12.26	Element change: addtionalCOFData New Parent Elements: `authReversal`, `credit`	For successful payments using Visa’s Buy Now, Pay Later program, `additionalCOFData` and its child element `uniqueId` must be present.
12.27	New Element added: authMax Parent Elements: `authorizationResponse`, `saleResponse` Child Elements: `authMaxApplied`, `authMaxResponseCode`, `authMaxResponseMessage`, `networkToken`, `networkTokenApplied`	Additional elements added to auth and sale responses when AuthMax is used with a Network Payment Token.
12.27	Element changes: ticketNumber - maxLength changed from 25 to 15 issuingCarrier - minLength changed from 4 to 0 passengerClass - removed from schema. ticketChangeIIndicator - changed type from string to enum (N or C) carrierCode - minLength changed from noMin to 2	Various changes to child elements of `passengerTransportData` and `tripLegData`.
12.28	Element changes: tripLegData Changed max usage from 99 to 998.	Increases the Rail Travel `tripLegCount` usage limit for Discover and Mastercard to 998 from a current limit of 99.
12.29	New Element added: sellerInfo Parent Elements: `authorization`, `sale` Child Elements: `accountNumber`, `aggregateOrderCount`, `aggregateOrderDollars`, `sellerAddress`, `createdDate`, `domain`, `email`, `lastUpdateDate`, `name`, `onboardingEmail`, `onboardingIpAddress`, `parentEntity`, `phone`, `sellerId`, `sellerTags`, `username` New Element added: sellerAddress Parent Elements: `sellerInfo` Child Elements: `sellerStreetAddress`, `sellerUnit`, `sellerPostalCode`, `sellerCity`, `sellerProvinceCode`, `sellerCountryCode`	Use these optional elements if you are enabled for Guaranteed Payments and wish to pass additional details associated with transactions made by a third-party seller.
12.30	New Element added: `authIndicator` Parent Element: `authorization` New Element added: `authIndicator` Parent Element: `authorization`	Required if you submit an Incremental Authorization, used by certain Travel and Entertainment (T&E) merchants. when final purchase amounts are unknown.
12.31	New Element added: foreignRetailerIndicator Parent Elements: `capture`, `captureGivenAuth`, `forceCapture`, `sale`	New element must be present when the marketplace and retailer are not in the same region (country). A value of 'F' indicates that the retailer is located in a different country.
12.32	Element changes: customerIpAddress Type = String; minLength = N/A; maxLength= 100	Data type change due to support for IPv6 for Guaranteed Payments and Fraudsight.
12.33	New Element added: shipmentId Parent Element: `lineItemData` Element change: subscription New Parent Element: `lineItemData` New Child Elements: `subscriptionId`, `nextDeliveryDate`, `periodUnit`, `numberOfPeriods`, `regularItemPrice`, `currentPeriod`	Optional elements added to support recurring and subscription merchants for the Guaranteed Payments Service. This is an added functionality for the existing `subscription` element.
12.34	New Element added: echeckCustomerId Parent Element: `echeck` Element changes: businessIndicator - new enum values added: `accountToAccount`, `bankInitiated`, `fundsDisbursement`, `payrollDisbursement`, `personToPerson`, `topUp` `amount` - new type added in for certain PayFac transactions (`achTransactionAmountType`)	Optional element added as a child of `echeck` and the merchant-assigned customer identifier used for the account verification operation.
12.35	New Element added: accountFundingTransactionData Parent Elements: `authorization`, `sale` New Child Elements: `receiverFirstName`, `receiverLastName`, `receiverState`, `receiverCountry`, `receiverAccountNumber`, `receiverAccountNumberType` Element changes: orderChannel - new enum values added: `SCAN_AND_GO`, `SMART_TV` fulfilmentMethodType - new enum values added: `STANDARD_SHIPPING`, `EXPEDITED_SHIPPING`	Optional element and child elements added to define the receiver of the account funding transaction.
12.36	New Element added: fraudCheckAction Parent Elements: `authorization`, `sale` New Element added: finicityAccountRequest Parent Elements: `cnpOnlineRequest` Child Elements: `echeckCustomerId` New Element added: finicityAccountResponse Parent Elements: `cnpOnlineResponse` Child Elements: `cnpTxnId`, `response`, `responseTime`, `message`, `postDate`, `location`, `finicityAccount` New Element added: finicityURLRequest Parent Elements: `cnpOnlineRequest` Child Elements: `email`, `firstName`, `lastName`, `phoneNumber` New Element added: finicityURLResponse Parent Elements: `cnpOnlineResponse` Child Elements: `cnpTxnId`, `response`, `responseTime`, `message`, `postDate`, `location`, `echeckCustomerId`, `url` Element changes: accountFundingTransactionType - enum values added: `fundTransfer`, `walletTransfer`, `accountToAccount`, `bankInitiated`, `fundsDisbursement`, `payrollDisbursement`, `personToPerson`, `topUp personToPersonCardAccount`, `debitPrepaidAccount`, `paymentOfOwnCreditCardBill`, `businessDisbursement`, `businessToBusinessTransfer`, `governmentNonProfitDisbursement`, `rapidMerchantSettlement`, `agentCashOut` fraudCheckAction - enum values added: `APPROVED_SKIP_FRAUD_CHECK`, `DECLINED_NEED_FRAUD_CHECK` businessIndicator - enum values deprecated	Optional element to support Guaranteed Payment Service. The features associated with Finicity and Account Funding Transactions are not yet generally available. Please consult you Relationship Manager for additional information. The same enum values added for `accountFundingTransactionType` are deprecated for `businessIndicator`
12.37	New Element added: receiverAccountNumberType Parent Elements: `authorization`, `sale` Enum Values: `other`, `RTNAndBAN`, `IBAN`, `cardAccount`, `email`, `phoneNumber`, `BANAndBIC`, `walletID`, `socialNetworkID` New Element added: BNPLAuthorizationRequest Parent Elements: `cnpOnlineRequest` Child Elements: `orderId`, `provider`, `postCheckoutRedirectUrl`, `customerInfo`, `billToAddress`, `shipToAddress`, `enhancedData` New Element added: BNPLAuthorizationResponse Parent Elements: `cnpOnlineResponse` Child Elements: `cnpTxnId`, `response`, `responseTime`, `message`, `location`, `checkoutURL` New Element added: BNPLCaptureRequest Parent Elements: `cnpOnlineRequest` Child Elements: `amount`, `orderId`, `cnpTxnId` New Element added: BNPLCaptureResponse Parent Elements: `cnpOnlineResponse` Child Elements: `cnpTxnId`, `response`, `responseTime`, `message`, `location` New Element added: BNPLRefundRequest Parent Elements: `cnpOnlineRequest` Child Elements: `amount`, `orderId`, `cnpTxnId` New Element added: BNPLRefundResponse Parent Elements: `cnpOnlineResponse` Child Elements: `cnpTxnId`, `response`, `responseTime`, `message`, `location` New Element added: BNPLCancelRequest Parent Elements: `cnpOnlineRequest` Child Elements: `amount`, `orderId`, `cnpTxnId` New Element added: BNPLCancelResponse Parent Elements: `cnpOnlineResponse` Child Elements: `cnpTxnId`, `response`, `responseTime`, `message`, `location` New Element added: BNPLInquiryRequest Parent Elements: `cnpOnlineRequest` Child Elements: `amount`, `orderId`, `cnpTxnId` New Element added: BNPLInquiryResponse Parent Elements: `cnpOnlineResponse` Child Elements: `cnpTxnId`, `response`, `responseTime`, `message`, `location`, `inquiryResult` New Element added: postCheckoutRedirectUrl Parent Elements: `BNPLAuthorizationRequest` New Element added: inquiryResult Parent Elements: `BNPLInquiryResponse` New Element added: inquiryResultType Parent Elements: `BNPLInquiryResponse` Child Elements: `response`, `message`	The features associated with Visa Buy Now Pay Later (BNPL) and Account Funding Transactions are not yet generally available. Please consult you Relationship Manager for additional information.